Add custom trailing-slash sitemap#432
Merged
Merged
Conversation
sitemap.xml at the repo root overrides Mintlify's auto-generated (no-slash) sitemap with 569 trailing-slash URLs, matching the served/canonical form so canonical + sitemap + served URL all agree. - Generator lives in .github/scripts/generate-sitemap.mjs so Mintlify never builds it. A root-level scripts/*.mjs broke the Mintlify build in #430; isolation testing (PR #431) confirmed a bare sitemap.xml deploys cleanly (Mintlify Deployment = success) and the .mjs was the culprit. - `npm run generate-sitemap` regenerates it from docs.json navigation. - static-docs-checks CI regenerates and fails if sitemap.xml drifts. Registering with Google: submit https://www.checklyhq.com/docs-sitemap.xml in Search Console (the marketing proxy already serves the custom sitemap there). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Custom
sitemap.xml(569 trailing-slash URLs) that overrides Mintlifys auto-generated no-slash sitemap, so canonical + sitemap + served URL all agree on the trailing slash.Why this is safe now
PR #430 reverted the sitemap because the commit also added a root-level
scripts/generate-sitemap.mjsthat broke the Mintlify build. Isolation test (PR #431, sitemap.xml only) provedMintlify Deployment = success— the.mjswas the culprit, not the sitemap. This PR keeps the generator in.github/scripts/(Mintlify never builds that tree).Contents
sitemap.xml— 569 trailing-slash<loc>s, generated from docs.json nav..github/scripts/generate-sitemap.mjs— regenerates it (npm run generate-sitemap).static-docs-checksCI fails ifsitemap.xmldrifts from docs.json.scripts/dir, no.mintignorechange.Registering with Google (manual, after merge)
The custom sitemap serves at
https://www.checklyhq.com/docs-sitemap.xml(via the existing marketing proxy). It is NOT currently in robots.txt or the main sitemap index, so it must be submitted in Google Search Console -> Sitemaps. Optionally also add aSitemap:line to the marketing robots.txt for discovery.🤖 Generated with Claude Code